package risoe.syslab.fhnew.hw;

/*
 * Copyright (c) 2012-2014, Technical University of Denmark (DTU)
 * All rights reserved.
 * 
 * The Flexhouse 2.0 platform ("this software") is licensed under the
 * BSD 3-clause license.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of DTU nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE TECHNICAL UNIVERSITY OF DENMARK BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import risoe.syslab.fhnew.common.SystemConstants.DeviceType;
import risoe.syslab.fhnew.config.ActuatorConfig;
import risoe.syslab.model.CompositeMeasurement;
import java.io.Serializable;

@SuppressWarnings("serial")
public class Actuator implements Serializable{
  private String name;
  private DeviceType type;
  
  private CompositeMeasurement setpoint;
  private CompositeMeasurement value;
  
  private static final String unit="-"; //TODO: Implement
  
  public Actuator(ActuatorConfig sc) {
    name=sc.getName();
    type=sc.getType();
    setpoint=CompositeMeasurement.INVALID;
    value=CompositeMeasurement.INVALID;
  }
  
  public String getName() {
    return name;
  }
  
  public DeviceType getType() {
    return type;
  }

  public String getUnit() {
    return unit;
  }
  
  public void updateSetpoint(CompositeMeasurement s) {
    setpoint=s;
  }

  public void updateValue(CompositeMeasurement v) {
    value=v;
  }
  
  public boolean inEffect() {
    return (value.isGoodProcessValue() && setpoint.isGoodProcessValue() && value.value==setpoint.value);
  }
  
  public CompositeMeasurement getSetpoint() {
    return setpoint;
  }
  
  public CompositeMeasurement getValue() {
    return value;
  }
  
}

